|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Extension interface for IDocument
. Adds the concept of multiple partitionings.
Field Summary | |
static String |
DEFAULT_PARTITIONING
The identifier of the default partitioning. |
Method Summary | |
ITypedRegion[] |
computePartitioning(String partitioning,
int offset,
int length)
Computes the partitioning of the given document range based on the given partitioning. |
String |
getContentType(String partitioning,
int offset)
Returns the type of the document partition containing the given offset for the given partitioning. |
IDocumentPartitioner |
getDocumentPartitioner(String partitioning)
Returns the partitioner for the given partitioning or null if
no partitioner is registered. |
String[] |
getLegalContentTypes(String partitioning)
Returns the set of legal content types of document partitions for the given partitioning This set can be empty. |
ITypedRegion |
getPartition(String partitioning,
int offset)
Returns the document partition of the given partitioning in which the given offset is located. |
String[] |
getPartitionings()
Returns the exisiting partitionings for this document. |
void |
setDocumentPartitioner(String partitioning,
IDocumentPartitioner partitioner)
Sets this document's partitioner. |
Field Detail |
public static final String DEFAULT_PARTITIONING
Method Detail |
public String[] getPartitionings()
public String[] getLegalContentTypes(String partitioning) throws BadPartitioningException
getPartitioning(partitioning, 0, getLength())
.
partitioning
- the partitioning for which to return the legal content types
BadPartitioningException
- if partitioning is invalid for this documentpublic String getContentType(String partitioning, int offset) throws BadLocationException, BadPartitioningException
getPartition(partitioning, offset).getType()
.
partitioning
- the partitioningoffset
- the document offset
BadLocationException
- if offset is invalid in this document
BadPartitioningException
- if partitioning is invalid for this documentpublic ITypedRegion getPartition(String partitioning, int offset) throws BadLocationException, BadPartitioningException
partitioning
- the document partitioningoffset
- the document offset
BadLocationException
- if offset is invalid in this document
BadPartitioningException
- if partitioning is invalid for this documentpublic ITypedRegion[] computePartitioning(String partitioning, int offset, int length) throws BadLocationException, BadPartitioningException
partitioning
- the document's partitioningoffset
- the document offset at which the range startslength
- the length of the document range
BadLocationException
- if the range is invalid in this document
BadPartitioningException
public void setDocumentPartitioner(String partitioning, IDocumentPartitioner partitioner)
partitioning
- the partitioning for which to set the partitionerIDocumentPartitioningListener
public IDocumentPartitioner getDocumentPartitioner(String partitioning)
null
if
no partitioner is registered.
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |